Appliance Recovery Backup SystemName Archive FilterSpec

The Appliance Recovery Backup SystemName Archive FilterSpec schema contains properties used to filter the results when listing backup archives (see POST /appliance/recovery/backup/system-name/{systemName}/archives?action=list). If multiple properties are specified, only backup archives matching all of the properties match the filter.

This schema was added in vSphere API 6.7.

JSON Example

{
    "start_timestamp": "string",
    "end_timestamp": "string",
    "comment_substring": "string",
    "max_results": 0
}

string As date-time As date-time

start_timestamp

Optional

Backup must have been taken on or after this time to match the filter.

This property was added in vSphere API 6.7.

If missing or null the filter will match oldest backups.

string As date-time As date-time

end_timestamp

Optional

Backup must have been taken on or before this time to match the filter.

This property was added in vSphere API 6.7.

If missing or null the filter will match most recent backups.

string

comment_substring

Optional

Backup comment must contain this string to match the filter.

This property was added in vSphere API 6.7.

If missing or null the filter will match backups with any comment.

integer As int64 As int64

max_results

Optional

Limit result to a max count of most recent backups.

This property was added in vSphere API 6.7.

If missing or null it defaults to 128.